| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Static Public Member Functions | List of all members
nkAstraeus::EffectTypeUtils Class Referencefinal

Offers utility functions to help with the enumeration support. More...

## Static Public Member Functions
static nkMemory::StringView | enumToString (EFFECT_TYPE value)
static EFFECT_TYPE | stringToEnum (nkMemory::StringView value)

## Detailed Description

Offers utility functions to help with the enumeration support.

## Member Function Documentation

## ◆ enumToString()

static nkMemory::StringView nkAstraeus::EffectTypeUtils::enumToString | ( | EFFECT_TYPE | value | ) |
| static

Translates an enum value to a string. Values supported are :

Enum value | String value
--- | ---
EFFECT_TYPE::UNKNOWN | 'UNKNOWN'
EFFECT_TYPE::ATMOSPHERE | 'ATMOSPHERE'
EFFECT_TYPE::FILM_GRAIN | 'FILM_GRAIN'
EFFECT_TYPE::FXAA | 'FXAA'
EFFECT_TYPE::IMAGE_ENVIRONMENT | 'IMAGE_ENVIRONMENT'
EFFECT_TYPE::SSAO | 'SSAO'
EFFECT_TYPE::TEXTURE_COPY | 'TEXTURE_COPY'
EFFECT_TYPE::TONE_MAPPING | 'TONE_MAPPING'

Parameters

  value | The enumeration value to convert.

Returns
  The enumeration value name as a string.

## ◆ stringToEnum()

static EFFECT_TYPE nkAstraeus::EffectTypeUtils::stringToEnum | ( | nkMemory::StringView | value | ) |
| static

Translates a string to its enum value.

String value | Enum value
--- | ---
'ATMOSPHERE' | EFFECT_TYPE::ATMOSPHERE
'FILM_GRAIN' | EFFECT_TYPE::FILM_GRAIN
'FXAA' | EFFECT_TYPE::FXAA
'IMAGE_ENVIRONMENT' | EFFECT_TYPE::IMAGE_ENVIRONMENT
'SSAO' | EFFECT_TYPE::SSAO
'TEXTURE_COPY' | EFFECT_TYPE::TEXTURE_COPY
'TONE_MAPPING' | EFFECT_TYPE::TONE_MAPPING
'UNKNOWN' / Anything else | EFFECT_TYPE::UNKNOWN'

Parameters

  value | The string to convert.

Returns
  The enumeration value identified.

The documentation for this class was generated from the following file:

- Documentation/Headers/NilkinsAstraeus/Graphics/Effects/EffectType.h